home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 040a / mplay200.zip / MP.DOC < prev    next >
Text File  |  1991-09-05  |  17KB  |  402 lines
  1.  
  2.  
  3.      MODPLAY  *********                            (C) Mark J Cox
  4.      MODPLAY  **                                   1990/1991
  5.      MODPLAY  *******                              Freeware
  6.      MODPLAY  **************                       Version 2.00
  7.  
  8.      Play AMIGA 4 channel music on a PC
  9.  
  10.      I. QUICK START
  11.      ─────────────────────────────────────────────────────────
  12.  
  13.      If you are impatient and don't want to read all the documentation before 
  14.      trying this program, type:
  15.  
  16.                 mp -i            
  17.      or         mp -a-i   If your machine is 10Mhz - 12Mhz
  18.  
  19.  
  20.      II. QUICK GUIDE TO CHANGES
  21.      ─────────────────────────────────────────────────────────
  22.  
  23.      1          Now supports playing from ZIP's and LZH's as well as
  24.                 shelling to DOS.  Just create an archive with one file
  25.                 in it - the file being the .MOD file and make sure that
  26.                 somewhere on your path there is a copy of PKUNZIP and LHA
  27.                 (or batch files that run similar programs).
  28.  
  29.      2          If your video card supports text modes such as 25*132,
  30.                 44*132, 60*132 or just about any other text mode then enter
  31.                 this mode (using the utility supplied with your card) and
  32.                 MODPLAY will take full advantage of it.
  33.  
  34.  
  35.  
  36.      III.  INTRODUCTION TO MODPLAY
  37.      ─────────────────────────────────────────────────────────
  38.  
  39.      Modplay allows you to play Amiga soundtracker/noisetracker files
  40.      (or 4 channel Startrekker files) on a PC (10Mhz or faster clock speed).  
  41.      Modplay is written *entirely* in assembler and now runs to nearly
  42.      6,000 lines of source and has taken around 300 hours to produce.
  43.  
  44.  
  45.  
  46.      1.   WHAT ARE MODULES?
  47.      ─────────────────────────────────────────────────────────
  48.  
  49.      A module consists of 15 (or 31) sampled instruments and a four channel
  50.      music track.  By playing the instruments at different pitches a
  51.      soundtrack lasting many minutes can be produced.  The PC speaker is not
  52.      really up to handling modules, since in total we have a 10 bit sample
  53.      to be played, and the speaker can only handle 5 (and thats only just
  54.      possible).  A D/A converter gives 8 and the stereo version gives 
  55.      effectively 9. The output sounds OK through a good sized PC speaker, the 
  56.      cheap piezo devices found in some computers including laptops are not 
  57.      really designed to cope.  So through external harware MODPLAY comes 
  58.      close to the quality you would get on an AMIGA.
  59.  
  60.  
  61.      2. IMPLEMENTATION
  62.      ─────────────────────────────────────────────────────────
  63.  
  64.      MODPLAY implements all Amiga effects such as volume sliding, vibrato etc.
  65.      Most Amiga modules have samples in them that are less than 64k each in
  66.      length, these can be played as normal on any 286 10Mhz or better;  a
  67.      rare few have samples >64k in them and although these will be played
  68.      by modplay you really need a 16MHz machine minimum to keep up.  These 
  69.      modules are marked with a '*' on the top line of the display next to the
  70.      filename when they are playing.
  71.  
  72.  
  73.  
  74.      3. MODPLAY OPTIONS - COMMAND LINE PLAYING
  75.      ─────────────────────────────────────────────────────────
  76.  
  77.      From the command line a module can be played through any of the output
  78.      devices with or without a moving graph display.  The format is 
  79.  
  80.      MP [/q] [/0..6] [/a..c] filename [.MOD]
  81.  
  82.      Items in [ ] are optional.   The /q if present tells MODPLAY not to
  83.      display any text and so the module will play without disturbing the
  84.      text display.  (You could use this in a game's title screen written
  85.      in C or Basic, by doing a system or shell command - MODPLAY exits when
  86.      a key is pressed).  The /number tells MODPLAY what hardware to play
  87.      the module through.  The filename can contain wildcard characters
  88.      (*,?), so MODPLAY * would be valid and would play all the *.MOD files
  89.      in the current directory one after the other.  Playback of a sequence
  90.      of files can be aborted by pressing ESCape two or three times in rapid
  91.      sucession.  
  92.  
  93.      /0 is the PC Speaker
  94.      /1 is a D/A converter on printer port 1
  95.      /2 is a D/A converter on printer port 2
  96.      /3 is 2 D/A converters, one on port1 the other on port2 (gives stereo)
  97.      /4 is 2 D/A converters as above but giving mono.
  98.      /5 is a D/A converter on printer port 1 (when the port is on a video card)
  99.  
  100.      /xm
  101.        This is of use if you have a single D/A converter on an expansion
  102.        port or any known address.  Use /xm(address) where the address is
  103.        a 3 digit hex number.  (Example /xm3B7 would play in mono to a
  104.        D/A converter at address 03B7) 
  105.     
  106.      /xs
  107.        This is similar to /xm, allowing two D/A converters and hence stereo
  108.        operation.  Use /xs(address1)(address2).  [Example, /xs300301 would
  109.        play in stereo to D/A converters at 0300 and 0301.  Note that these
  110.        switchs must be used from the command line and cannot be changed when
  111.        inside MODPLAY
  112.  
  113.      Stereo-on-1
  114.        Modplay will autodetect a Stereo-on-1 board on any Parallel port and
  115.        use it.  See HARDWARE.DOC for more information
  116.  
  117.      Soundblaster
  118.        Modplay will autodetect a Soundblaster card at any base address and
  119.        use it. 
  120.  
  121.      (Using a /number will ignore anything autodetected).
  122.  
  123.      /a should be used if your computer crashes when playing tunes, it
  124.         decreases the rate of playing samples - decreasing the quality
  125.         noticably through the speaker, but should mean 10Mhz-12Mhz machines
  126.         can cope.
  127.      /b This is the default mixing speed designed for a 12MHz PC
  128.  
  129.      /d This option is used when if you don't like my choice of character 
  130.         for drawing the bars.  I've had lots of mail all saying you would
  131.         like different characters - so now you can choose your own,
  132.         Usage is /dxx where xx is a two-digit hexidecimal number of the 
  133.         character you want to use,
  134.  
  135.         /dF0    Would be ≡, the default bar
  136.         /df7    Would be ≈, one of my favorites
  137.         /d02    is quite fun for 'acid house' type mods. 
  138.  
  139.         And if you are still not satisfied, then pressing F1 or F2 when
  140.         playing changes the character as well!  F3 and F4 even change the
  141.         colour of the moving bar.  Hours of fun (yawn)!
  142.  
  143.      Playing is stopped by pressing *any* key, or when the module is finished
  144.      Modules that loop at the end, or jump backwards are stopped so they
  145.      will only play once.
  146.  
  147.      There are some special keys, described in the next section that can
  148.      be used to whiz through a module like a CD player.
  149.  
  150.  
  151.  
  152.      4. MODPLAY IN INTERACTIVE MODE
  153.      ─────────────────────────────────────────────────────────
  154.  
  155.      MP /i will bring up a display menu screen - help on all key presses
  156.      is available by pressing F1.   From this screen you can change
  157.      directory, change drive or play one or more modules.
  158.  
  159.      The commands allowed are:
  160.  
  161.      Basic Keys:
  162.  
  163.  
  164.      Cursor Keys Move the highlight bar together with the 'PgUp',
  165.                  'PgDn', 'Home' and 'End' keys.
  166.  
  167.      <SPACE>     This will play the current module highlighted, or change
  168.                  to the directory or drive hightlighted
  169.  
  170.      <ESC>       Quits modplay
  171.  
  172.      <c>         Steps through the allowed output devices
  173.  
  174.      <!>         Lets you perform DOS commands.
  175.  
  176.   
  177.      Advanced:
  178.  
  179.  
  180.      <t>         Tags the currently highlighted module (displays a "+")
  181.                  or untags the module if already tagged.
  182.  
  183.      <T>         Tags all modules in directory
  184.  
  185.      <U>         Untags all modules in directory
  186.  
  187.      <p>         Plays all tagged modules in sequence.
  188.  
  189.      <s>         Takes you into the Sample sub-menu screen
  190.  
  191.  
  192.      Sample Sub-menu:
  193.  
  194.  
  195.      From here you can look at the samples that make up the module - there
  196.      are a few special keys that perform various functions that are not
  197.      fully tested and are provided for users that know what they are
  198.      doing (i.e. not bomb proof input routines!)
  199.  
  200.      <p>         Plays the sample highlighted
  201.  
  202.      <m>         Plays the whole module
  203.  
  204.      <w>         Prompts for a filename and then saves the sample to disk
  205.  
  206.      <r>         Reads a new sample into the old slot.
  207.  
  208.  
  209.  
  210.      5. PLAYBACK KEYS
  211.      ───────────────────────────────────────────────────────── 
  212.  
  213.      During any playback, pressing the left arrow key will slow the music
  214.      down, the right arrow key will speed it up and the down arrow key
  215.      restores to default speed.  The PageDown key will skip to the next
  216.      track, PageUp jumps back one track.  The END key will (almost)
  217.      pause the music, with the down arrow key restoring the speed.
  218.  
  219.  
  220.  
  221.      6. TEST MODE
  222.      ───────────────────────────────────────────────────────── 
  223.  
  224.      You can obtain an alternative display when playing modules from the
  225.      interactive mode by starting MODPLAY with the /t/i switches.  This
  226.      display may not update quickly enough on slower machines.
  227.  
  228.  
  229.  
  230.      7. ARCHIVED MODULES
  231.      ─────────────────────────────────────────────────────────
  232.  
  233.      Using a popular archiving utility normally saves about 30% of disk space
  234.      for modules.  Support is now added so that MODPLAY will automatically 
  235.      find and play modules stored in archives (in interactive mode only at
  236.      present).   Modules can be archived into LZH or ZIP formats and there
  237.      must be only one module per archive (modules must have a .MOD extension)
  238.      MODPLAY runs your unpacker for you, creating the .MOD file temporarily on
  239.      your hard disk; plays the .MOD file then deletes it.  To play ZIP files
  240.      you must have a program or a batch file called PKUNZIP somewhere on your
  241.      path; to play LZH files you must have a program called LHARC.
  242.      If you have a better method you would like adding, please let me know.
  243.     
  244.  
  245.  
  246.      8. SOURCE OF MODULES
  247.      ─────────────────────────────────────────────────────────
  248.  
  249.      You can obtain modules from many Bulletin Boards,  Internet sites or from
  250.      friends Amiga's.  Modules usually come archived in LZH form, these can be 
  251.      unpacked with the excellent LHARC program.  The files will usually unpack 
  252.      as 'mod.something' and so MSDOS cuts them short to 'mod.SOM' and it is 
  253.      best to rename these to 'something.mod' so that MODPLAY will automatically 
  254.      detect them.
  255.  
  256.  
  257.  
  258.      9. FREEWARE
  259.      ─────────────────────────────────────────────────────────
  260.  
  261.      This software is Freeware - that means that there is no registration fee,
  262.      you can copy this software, give it to anyone, and use it for anything 
  263.      (subject to the license at the end of this document).  If you like this
  264.      software, and would like the author to continue writing-  a gift would be
  265.      appreciated, send any spare UK currency you have left (from holiday etc.)
  266.      8-)
  267.  
  268.                   *** Was free,  Is free,  Always free ***
  269.  
  270.  
  271.      10. CREDITS & THANKS DUE TO:
  272.      ─────────────────────────────────────────────────────────
  273.  
  274.      ╔════════════════════════════════════════════════════════════════════════╗
  275.      ║                                                                        ║
  276.      ║ DABS PRESS           - For providing a Soundblaster Board that enabled ║
  277.      ║ Manchester, UK         MODPLAY to finally work with it!  DABS PRESS    ║
  278.      ║                        supply PC's and a whole host of peripherals,    ║
  279.      ║                        including Soundblaster boards at excellent      ║
  280.      ║                        prices.  Look at the adverts in most UK         ║
  281.      ║                        computer magazines or ring 061-773 8632 now!    ║
  282.      ║                                                                        ║
  283.      ╚════════════════════════════════════════════════════════════════════════╝
  284.  
  285.      Mahoney & Kaktus     - A sample Amiga assembler noisetracker replay
  286.                             routine that provided some details on how a
  287.                             module was comprised and sparked the initial
  288.                             idea.
  289.  
  290.      Francois Jalbert     - For spending hours wading through my source code
  291.                             looking for a nasty bug that only seemed to occur
  292.                             when we were not looking for it - and providing
  293.                             moral support when I get bored of coding.
  294.  
  295.      Norman Lin (Modedit) - Who pointed out a few mistakes in my
  296.                             initial implementation.   
  297.  
  298.      Derek Beacroft       - For obtaining the Soundblaster programming
  299.                             information and other ideas
  300.  
  301.      Paul/Pete/Phil       - For finding all the bugs in pre-release versions
  302.                             and picking holes in the documentation
  303.  
  304.      And the other (now over 100) people who have commented on MODPLAY and
  305.      given ideas for the future. 
  306.  
  307.  
  308.  
  309.      11. COPYRIGHT/LICENSE/WARRANTY
  310.      ─────────────────────────────────────────────────────────
  311.  
  312.      The files MP.COM, HARDWARE.DOC and this document MP.DOC ("the
  313.      software") are copyrighted by the author. The copyright owner hereby
  314.      licenses you to:  use the software; make as many copies of the program
  315.      and documentation as you  wish; give such copies to anyone; and
  316.      distribute the software and  documentation via electronic means.  
  317.     
  318.      You are specifically prohibited from charging, or requesting donations,
  319.      for  any such copies, however made; and from distributing the software
  320.      and/or  documentation with commercial products without written
  321.      contract.
  322.     
  323.      This software may be distributed in Shareware/Public Domain libraries
  324.      that charge for copying and distributing disks.
  325.     
  326.      ║ No Copy Of The Software May Be Distributed Or Given Away Without   ║
  327.      ║ This Document; And Neither The Program Or Document May Be Altered  ║
  328.      ║ In Any Way, Or Reverse-Engineered By Disassembly Or Other Method.  ║
  329.     
  330.      There is no warranty of any kind, and the copyright owner is not liable
  331.      for damages of any kind.  By using this free software, you agree to
  332.      this.
  333.     
  334.      The software and documentation are  
  335.      Copyright (C) 1990/1991 by Mark J Cox
  336.  
  337.  
  338.  
  339.      12. EXAMPLE QUESTIONS
  340.      ─────────────────────────────────────────────────────────
  341.      
  342.      These are a selection of comments/suggestions and questions I have
  343.      received.
  344.  
  345.      Q. I keep getting 'Divide Error' and my computer locks up
  346.      A. Some modules I have seen are corrupt - there is no way MODPLAY can 
  347.         tell and there is no time to do any checks - use the 's' command and
  348.         you should be able to see if the module has any garbage in it.
  349.  
  350.      Q. It sounds like my computer is about to explode.
  351.      A. You have a small piezo speaker - why not build a resistor D/A as
  352.         explained above or put a nice sized speaker (Radio Shack/Tandy) in
  353.         instead.
  354.  
  355.      Q. Can I edit modules?
  356.      A. Not with MODPLAY - use MODEDIT written by Norman Lin that uses
  357.         MODRES a resident version of MODPLAY
  358.  
  359.      Q. Ever thought of supporting 8 channels like 'Startreker'?
  360.      A. Yeah, but you would need a 386-33 to run it...and I haven't found
  361.         enough modules that support it yet though.
  362.  
  363.      Q. I can't find this ZN426E chip
  364.      A. Try MAPLIN (if you are in the UK) otherwise you could always 
  365.         substitute any D/A or use the resistor version
  366.  
  367.      Q. I really like MODPLAY
  368.      A. A gift would be appreciated :-)
  369.  
  370.      Q. "Speech on the IBM PC is not just a case of 'yet another Lotus-1-2-3'
  371.          but a basic piece of innovative software which is being incorporated
  372.          into several commercial products at this very moment.  Releasing an
  373.          un-supported non-commercial product of this nature is a highly 
  374.          irresponsible act which we cannot stand by and watch without doing our
  375.          utmost to prevent" - A UK company talking about the PLAY program.
  376.      A. (I'll let you make your own answer up, send me your favourite)
  377.  
  378.  
  379.  
  380.      13. CONTACT/SUPPORT
  381.      ─────────────────────────────────────────────────────────
  382.  
  383.      Before June 1992:
  384.      -----------------
  385.      Mark J Cox                 Electronic Mail: 
  386.      17 Kirkburn Place           (JANET) m.j.h.cox@uk.ac.bradford (UK)
  387.      Bradford                            m.j.h.cox@bradford.ac.uk (other)
  388.      W. Yorks, UK              (NETMAIL) Post a message in PLAY SUPPORT on
  389.      BD7 2BZ                             Kingdom of Greyhawk BBS
  390.                                          (+44 332 756414)
  391.      After June 1992:
  392.      ----------------
  393.      29 Lundie Close           (NETMAIL) Post a message in PLAY SUPPORT on
  394.      Stenson Fields                      Kingdom of Greyhawk BBS
  395.      Derby, UK                           (+44 332 756414)
  396.      DE2 3AN
  397.  
  398.      All comments on PLAY, RESPLAY, MODPLAY or future software are welcomed!
  399.      Please enclose a SSAE for quicker reply.
  400.  
  401.      Any company need a PC assembler programmer?
  402.